🩹 [Patch]: Refactor release notes handling to improve clarity and structure #81
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR refactors how release notes are built in scripts/main.ps1 by splitting title and body handling into separate steps, ensuring notes are only passed when non-empty, and adding debug output of the final gh arguments.
- Separate title and body concatenation into two distinct conditional blocks for clarity
- Added check to only append
--noteswhen$notesis non-empty, falling back to--generate-notes - Enhanced debugging by printing the constructed
ghcommand arguments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This pull request refactors the logic for constructing release notes in
scripts/main.ps1to improve clarity and maintainability. The changes separate the handling of PR title and body into distinct blocks and ensure that notes are only added when they are non-empty.Improvements to release notes construction:
$notesas an empty string and append the PR title and body conditionally, instead of combining them in a single step. This improves readability and modularity.$notesis non-empty before appending it to the$releaseCreateCommand, preventing unnecessary arguments when no notes are provided.gharguments for better traceability during execution.